Devlopment Coding Docs initial start.#413
Merged
shlomi-noach merged 6 commits intomasterfrom Jun 4, 2017
Merged
Conversation
- It is a bit sparse currently, but will give beginners an idea how on to setup the environment and run tests. - A good starting point for further PR's.
shlomi-noach
reviewed
May 4, 2017
Contributor
shlomi-noach
left a comment
shlomi-noach
left a comment
There was a problem hiding this comment.
Thank you for working on this!
| - It runs `script/bootstrap` | ||
| - `script/bootstrap` runs `script/ensure-go-installed` | ||
| - `script/ensure-go-installed` installs go locally if (go is not installed) || (go is not version 1.7). It will not install go if it is already installed locally and at the correct version. | ||
| - `script/build` builds the `gh-ost` binary and places in in `bin/` |
Contributor
There was a problem hiding this comment.
I think enumerating the exact steps taken by the script is error prone. e.g. what happens if the script ensures go 1.8 -- will this text be updated?
Contributor
Author
There was a problem hiding this comment.
Good point, let me strip this down.
|
|
||
| Getting started with gh-ost development is simple! | ||
|
|
||
| - First clone the repository. |
Contributor
There was a problem hiding this comment.
Should we clone via git clone or via go get?
|
|
||
| We develop `gh-ost` at GitHub and for the community. We may have different priorities than others. From time to time we may suggest a contribution that is not on our immediate roadmap but which may appeal to others. | ||
|
|
||
| Please see [Coding gh-ost](https://github.com/github/gh-ost/blob/develdocs/doc/command-line-flags.md) for a guide to getting started developing with gh-ost. |
Contributor
Author
|
@shlomi-noach Are additional changes needed before merging this PR? |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Overview
After cloning the repository I was struggling with how to get started working with the
gh-ostcodebase.I have submitted this PR in order to start a page guiding prospective contributers on how to get started with
gh-ostdevelopment.While this page is simple for now, I am hoping that it is a good springboard to further PR's on this documentation.
Related issue: #412
Description
This PR creates a
doc/coding-ghost.mdfile that contains instructions for runningcibuild. It also details the steps thatcibuildperforms.